Payment Initiation APIs
Payments Submission Examples
This section provides example of different requests and responses for the different Payments Submission APIs:
Domestic Payments APIs
Once the domestic payment consent has been authorised by the PSU, the PISP can proceed to submitting the domestic payments for processing by making a POST request to the domestic payments endpoint.
POST request: Domestic Payments submission
POST /domestic-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceGoods",
"MerchantCategoryCode": "5967",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "AcaciaAvenue",
"BuildingNumber": "27",
"PostCode": "7U31 2ZZ",
"TownName": "Sparsholt",
"Country": "IE"
}
}
}'POST response: Domestic Payments submission
The following optional field(s) is/are not populated by BOI for this API:
• MultiAuthorisation.NumberRequired
• MultiAuthorisation.NumberReceived
• MultiAuthorisation.LastUpdateDateTime
• MultiAuthorisation.ExpirationDateTime
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"CreationDateTime": "2019-02-06T10:33:36+00:00",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
},
"Meta": {}
}A PISP can retrieve the domestic payment to check its status by making a GET request to the domestic payments endpoint with the DomesticPaymentId generated from the POST request.
GET request:Domestic Payments submission
GET /domestic-payments/b199886e-e661-488e-9313-f4062a8698c9 HTTP/1.1
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42 \
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20'GET response: Domestic Payments submission
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"CreationDateTime": "2019-02-06T10:33:36+00:00",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
},
"Meta": {}
}Domestic Payments (CHAPS Payment) APIs
POST request: CHAPS Domestic Payments submission
POST /domestic-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.CHAPS",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceGoods",
"MerchantCategoryCode": "5967",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "AcaciaAvenue",
"BuildingNumber": "27",
"PostCode": "7U31 2ZZ",
"TownName": "Sparsholt",
"Country": "IE"
}
}
}'POST response: CHAPS Domestic Payments submission
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"CreationDateTime": "2019-02-06T10:33:36+00:00",
"LocalInstrument": "UK.OBIE.CHAPS",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
},
"Meta": {}
}GET request: CHAPS Domestic Payments submission
GET /domestic-payments/b199886e-e661-488e-9313-f4062a8698c9 HTTP/1.1
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42 \
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20'GET response: CHAPS Domestic Payments submission
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "9fb620fe-9145-4594-81c0-39c82b30cb42",
"ConsentId": "c4cd37de-aa69-4fbe-83aa-198b807948d6",
"CreationDateTime": "2019-02-06T10:33:36+00:00",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T10:33:36+00:00",
"LocalInstrument": "UK.OBIE.CHAPS",
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42"
},
}
Domestic Payments (SDMT Payment) APIs
POST request: SDMT Domestic Payments submission
POST /domestic-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date': Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "b1ffb429-a861-40c5-9787-49947857c992",
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE43BOFI90159797017815",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceGoods",
"MerchantCategoryCode": "5967",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"AddressLine": [
"Flat 7",
"Acacia Lodge"
],
"StreetName": "AcaciaAvenue",
"BuildingNumber": "27",
"PostCode": "7U31 2ZZ",
"TownName": "Sparsholt",
"Country": "IE"
}
}
}POST response: SDMT Domestic Payments submission
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "19899519-5692-4ddd-af42-cdd759e73281",
"ConsentId": "b1ffb429-a861-40c5-9787-49947857c992",
"CreationDateTime": "2023-05-10T15:12:42+05:30",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2023-05-10T15:12:42+05:30",
"ExpectedExecutionDateTime": "2023-05-11T15:12:42+05:30",
"ExpectedSettlementDateTime": "2023-05-12T15:12:42+05:30",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel"
}
},
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE43BOFI90159797017815",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised"
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1/pisp/domestic-payments/19899519-5692-4ddd-af42-cdd759e73281"
},
"Meta": {}
}GET request: SDMT Domestic Payments submission
GET /domestic-payments/b199886e-e661-488e-9313-f4062a8698c9 HTTP/1.1
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-payments/9fb620fe-9145-4594-81c0-39c82b30cb42 \
-H 'Authorization: Bearer VS6VAWqqfI2sKOh4iuwgEgPPgduw' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20'GET response: SDMT Domestic Payments submission
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticPaymentId": "19899519-5692-4ddd-af42-cdd759e73281",
"ConsentId": "b1ffb429-a861-40c5-9787-49947857c992",
"CreationDateTime": "2023-05-10T15:12:42+05:30",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2023-05-10T15:12:42+05:30",
"ExpectedExecutionDateTime": "2023-05-11T15:12:42+05:30",
"ExpectedSettlementDateTime": "2023-05-12T15:12:42+05:30",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel"
}
},
"Initiation": {
"InstructionIdentification": "ABDDCF",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.Target2",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE43BOFI90159797017815",
"Name": "Test user",
"SecondaryIdentification": "TPP Provided Value"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised"
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1/pisp/domestic-payments/19899519-5692-4ddd-af42-cdd759e73281"
},
"Meta": {}
}Domestic scheduled payments APIs
POST request: Domestic scheduled payments
POST /domestic-scheduled-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-scheduled-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
"LocalInstrument": "UK.OBIE.FPS",
"InstructedAmount": {
"Amount": "300.33",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Reference": "DSR-037qwertyuiotrye",
"Unstructured": "Internal ops code 5120103"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty"
}
}'POST response: Domestic scheduled payments
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticScheduledPaymentId": "a7cc1990-9c58-4a68-9f43-dc9025ffd825",
"ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
"CreationDateTime": "2019-02-06T11:22:08+00:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2019-02-06T11:22:08+00:00",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.FPS",
"RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
"InstructedAmount": {
"Amount": "310.33",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120103",
"Reference": "DSR-037qwertyuiotrye"
}
}
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-scheduled-payments/a7cc1990-9c58-4a68-9f43-dc9025ffd825"
},
"Meta": {}
}Domestic Scheduled Payments (CHAPS Payment) APIs
POST request: CHAPS Domestic scheduled payments
POST /domestic-scheduled-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-scheduled-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
"LocalInstrument": "UK.OBIE.CHAPS",
"InstructedAmount": {
"Amount": "300.33",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Reference": "DSR-037qwertyuiotrye",
"Unstructured": "Internal ops code 5120103"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty"
}
}'POST response: CHAPS Domestic scheduled payments
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticScheduledPaymentId": "a7cc1990-9c58-4a68-9f43-dc9025ffd825",
"ConsentId": "58f09fb4-e6a0-4897-953f-a5a0a927d7ea",
"CreationDateTime": "2019-02-06T11:22:08+00:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2019-02-06T11:22:08+00:00",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.CHAPS",
"RequestedExecutionDateTime": "2019-05-01T19:00:00-05:00",
"InstructedAmount": {
"Amount": "310.33",
"Currency": "GBP"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325698",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120103",
"Reference": "DSR-037qwertyuiotrye"
}
}
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-scheduled-payments/a7cc1990-9c58-4a68-9f43-dc9025ffd825"
},
}
Domestic Scheduled Payments (SDMT Payment) APIs
POST request: SDMT Domestic scheduled payments
POST /domestic-scheduled-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-scheduled-payments \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "8de149b6-da20-4ec1-8309-965a732ed3c1",
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.Target2",
"RequestedExecutionDateTime": "2023-06-01T19:00:00-05:00",
"InstructedAmount": {
"Amount": "300.3",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE43BOFI90159797017815",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Reference": "DSR-037qwertyuiotrye",
"Unstructured": "Internal ops code 5120103"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty"
}
}POST response: SDMT Domestic scheduled payments
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticScheduledPaymentId": "0f40b915-1ba5-4bfd-9e6a-ce9195daa186",
"ConsentId": "8de149b6-da20-4ec1-8309-965a732ed3c1",
"CreationDateTime": "2023-05-10T15:37:52+05:30",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2023-05-10T15:37:52+05:30",
"ExpectedExecutionDateTime": "2023-05-11T15:37:52+05:30",
"ExpectedSettlementDateTime": "2023-05-12T15:37:52+05:30",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "90883965880313",
"Name": "Grey Chappel"
}
},
"Initiation": {
"InstructionIdentification": "abcdefghijklmnop",
"EndToEndIdentification": "DEMO USER",
"LocalInstrument": "UK.OBIE.Target2",
"RequestedExecutionDateTime": "2023-06-01T19:00:00-05:00",
"InstructedAmount": {
"Amount": "300.3",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE43BOFI90159797017815",
"Name": "Tom Kirkman"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120103",
"Reference": "DSR-037qwertyuiotrye"
}
},
"MultiAuthorisation": {
"Status": "Authorised"
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1/pisp/domestic-scheduled-payments/0f40b915-1ba5-4bfd-9e6a-ce9195daa186"
},
"Meta": {}
}
Domestic standing orders APIs
POST request: Domestic standing orders
POST /domestic-standing-orders HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-standing-orders \
-H 'Authorization: Bearer GExRm6odmyvi4KkLLPQ6gkZl5Vwc' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date' : Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "85484c7e-0442-4b14-b50d-c85fbbd9c89a",
"Initiation": {
"Frequency": "IntrvlWkDay:01:03",
"Reference": "3asdfaasg43534534653463",
"FirstPaymentDateTime": "2019-03-01T06:06:06.777Z",
"FirstPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"RecurringPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"FinalPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Bob Clements",
"SecondaryIdentification": "00e"
}
}
},
"Risk": {
"PaymentContextCode": "EcommerceServices",
"MerchantCategoryCode": "0122",
"MerchantCustomerIdentification": "Test",
"DeliveryAddress": {
"AddressLine": [
"Test",
"Test"
],
"StreetName": "Test2",
"BuildingNumber": "8",
"PostCode": "ABCDEF 123456&",
"CountrySubDivision": "Testsubdivision",
"TownName": "Townname6780",
"Country": "IE"
}
}
}'POST response: Domestic standing orders
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"DomesticStandingOrderId": "80c2bee9-304b-4052-94ba-f7578cc06e1e",
"ConsentId": "85484c7e-0442-4b14-b50d-c85fbbd9c89a",
"CreationDateTime": "2019-02-06T13:02:06+00:00",
"Status": "InitiationPending",
"StatusUpdateDateTime": "2019-02-06T13:02:06+00:00",
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
},
"Initiation": {
"Frequency": "IntrvlWkDay:01:03",
"Reference": "3asdfaasg43534534653463",
"FirstPaymentDateTime": "2019-03-01T06:06:06.777Z",
"FirstPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"RecurringPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"FinalPaymentAmount": {
"Amount": "400.00",
"Currency": "EUR"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE40BOFI90123968920165",
"Name": "Bob Clements",
"SecondaryIdentification": "00e"
}
},
"MultiAuthorisation": {
"Status": "AwaitingFurtherAuthorisation",
"NumberRequired": 2,
"NumberReceived": 1,
"LastUpdateDateTime": "2019-02-06T13:02:06+00:00",
"ExpirationDateTime": "2019-02-09T13:02:06+00:00"
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/domestic-standing-orders/80c2bee9-304b-4052-94ba-f7578cc06e1e"
},
"Meta": {}
}International Payments APIs
The following examples are for B365 customers. For Business On Line users, please see the example under International Scheduled Payment Submission.
Once the international payment consent has been authorised by the PSU, the PISP can proceed to submitting the international payments for processing by making a POST request to the international payments endpoint. Note - The ExchangeRate and Charges block under Data block will be returned only if the Consent Status is "Authorised" or "Consumed".
POST request: International Payment submission
POST /international-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/international-payments \
-H 'Authorization: Bearer d4n2KALliFFjeTo6at1JhuKyB4Y7' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: 351' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
"Initiation": {
"InstructionIdentification": "International",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructionPriority": "Normal",
"LocalInstrument": "UK.OBIE.SWIFT",
"CurrencyOfTransfer": "HRK",
"ChargeBearer": "Shared",
"InstructedAmount": {
"Amount": "300.22",
"Currency": "HRK",
},
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"RateType": "Actual"
},
"Creditor": {
"Name": "test",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
},
"CreditorAgent": {
"SchemeName": “UK.OBIE.BICFI”,
"Identification": "NBHRHR2XXXX",
"Name": "test User",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "HR1210010051863000160",
"Name": "Test user",
"SecondaryIdentification": "2"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty",
"MerchantCategoryCode": "5967",
"MerchantCustomerIdentification": "053598653254",
"DeliveryAddress": {
"StreetName": "AcaciaAvenue",
"BuildingNumber": "27",
"PostCode": "7U31 2ZZ",
"TownName": "Sparsholt",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
}
}'POST response: International Payments submission
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"InternationalPaymentId": "325467fb-ac6f-48e0-b701-8415291de970",
"ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
"CreationDateTime": "2019-02-06T11:09:52+00:00",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T11:09:52+00:00",
"Charges": [
{
"ChargeBearer": “Shared”,
"Type": "UK.OBIE.INTERNATIONALPAYMENTOUT",
"Amount": {
"Amount": "15.00",
"Currency": "GBP"
}
}
],
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"ExchangeRate": 1.2,
"RateType": "Actual",
"ExpirationDateTime": "2019-02-06T11:19:52+00:00"
},
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
"Creditor": {
"Name": "test",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
"Agent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "Test",
"PostalAddress": {
"AddressType": "Residential",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test",
"Country": "HR",
"CountrySubDivision": "Test1",
"AddressLine": [
"Test2",
"Test3",
"Test4"
]
},
"Initiation": {
"InstructionIdentification": "International",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructionPriority": "Normal",
"ChargeBearer": "Shared",
"LocalInstrument": "UK.OBIE.SWIFT",
"CurrencyOfTransfer": "HRK",
"InstructedAmount": {
"Amount": "910.22",
"Currency": "HRK",
},
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"RateType": "Actual"
},
"Creditor": {
"Name": "test",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "test User",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "HR1210010051863000160",
"Name": "Test user",
"SecondaryIdentification": "2"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970"
},
}A PISP can retrieve the international-payments to check its status by making a GET request to the international-payments endpoint with the internationalPaymentId generated from the POST request.
GET request: International Payments submission
GET /international-payments/7c64852c-53e3-4a00-99b4-608f1b525ba9 HTTP/1.1
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970 \
-H 'Authorization: Bearer MSdQrRyLqftG6NbSfOdSGntgPeTQ' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c74aafda-b8b6-4308-9ec3-1190c55332b9' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20'GET International Payments submission response
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"InternationalPaymentId": "325467fb-ac6f-48e0-b701-8415291de970",
"ConsentId": "d4f92364-e27f-4c9f-b583-89a84bdf1b47",
"CreationDateTime": "2019-02-06T11:09:52+00:00",
"Status": "AcceptedSettlementInProcess",
"StatusUpdateDateTime": "2019-02-06T11:09:52+00:00",
"Charges": [
{
"ChargeBearer": "Shared",
"Type": "UK.OBIE.INTERNATIONALPAYMENTOUT",
"Amount": {
"Amount": "3.00",
"Currency": "GBP"
}
}
],
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"ExchangeRate": 1.2,
"RateType": "Actual",
"ExpirationDateTime": "2019-02-06T11:19:52+00:00"
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
}
"Agent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "Test",
"PostalAddress": {
"AddressType": "Residential",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test",
"Country": "HR",
"CountrySubDivision": "Test1",
"AddressLine": [
"Test2",
"Test3",
"Test4"
]
},
},
"Initiation": {
"InstructionIdentification": "International",
"EndToEndIdentification": "FRESCO.21302.GFX.20",
"InstructionPriority": "Normal",
"ChargeBearer": "Shared",
"CurrencyOfTransfer": "HRK",
"InstructedAmount": {
"Amount": "300.22",
"Currency": "HRK",
},
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"RateType": "Actual"
},
"Creditor": {
"Name": "test",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "test User",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": [
"Flat 7",
"Acacia Lodge"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "HR1210010051863000160",
"Name": "Test user",
"SecondaryIdentification": "2"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-payments/325467fb-ac6f-48e0-b701-8415291de970"
},
}International scheduled payments APIs
Following example cater to Business Online journeys.
POST request: International scheduled payments . Note - The ExchangeRate and Charges block under Data block will be returned only if the Consent Status is "Authorised" or "Consumed".
POST /international-scheduled-payments HTTP/1.1
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/international-scheduled-payments \
-H 'Authorization: Bearer d4n2KALliFFjeTo6at1JhuKyB4Y7' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: cadecc27-5c16-46c0-bbcc-00b7f9fcd219' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: TGlmZSdzIGEgam91cm5leSBub3QgYSBkZXN0aW5hdGlvbiA=..T2ggZ29vZCBldmVuaW5nIG1yIHR5bGVyIGdvaW5nIGRvd24gPw==' \
-d '{
"Data": {
"ConsentId": "20ae99ae-7a47-4e8a-a117-adf3199d8a1e",
"Initiation": {
"InstructionIdentification": "ACME412331",
"LocalInstrument": "UK.OBIE.SWIFT",
"InstructionPriority": "Normal",
"ChargeBearer": "Shared",
"RequestedExecutionDateTime": "2019-02-10T05:00:00Z",
"CurrencyOfTransfer": "HRK",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "HRK",
},
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"RateType": "Indicative"
},
"Creditor": {
"Name": "NameTest",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": []
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "HR1210010051863000160",
"Name": "ACME Inc",
"SecondaryIdentification": "ee"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "Test",
"PostalAddress": {
"AddressType": "Residential",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test",
"Country": "HR",
"CountrySubDivision": "Test1",
"AddressLine": [
"Test2",
"Test3",
"Test4"
]
}
},
"RemittanceInformation": {
"Reference": "FRESCO-101",
"Unstructured": "Internal ops code 5120101"
}
}
},
"Risk": {
"PaymentContextCode": "PartyToParty",
"MerchantCategoryCode": "0222",
"MerchantCustomerIdentification": "Test",
"DeliveryAddress": {
"AddressLine": [
"Test",
"Acacia Lodge"
],
"StreetName": "AcaciaAvenue",
"BuildingNumber": "27",
"PostCode": "7U31 2ZZ",
"TownName": "Test",
"Country": "HR",
"CountrySubDivision": "Test"
}
}
}'POST response: International scheduled payments
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0MzU1ODcxNywiY3JpdCI6WyJiNjQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pYXQsaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoieGwxNkJEeHc1N0pOLTNQdHZybXlBLXpXVGdNIiwiY3R5IjoiYXBwbGljYXRpb25cL2pzb24iLCJ0eXAiOiJKT1NFIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiOiJDTj02ZGkyRGU4OHM4RDJ6VlhneXhtMGIyLE9VPVRlc3QgUEtJLE89T3BlbiBCYW5raW5nIExpbWl0ZWQsQz1HQiIsImFsZyI6IlJTMjU2In0..KLhgqQrAcYMugeVzd5-hFHwY40dmVpqwbt658alSHYTWi80JxiZXt5yiIHNMSJuO6eOKBXCjfl23FHtXkt-qSomv--r1orvYQGAV50Hux0zwNQT0FN7Lo43HjpuocWNKNbHF9asyz3z7D7spUFnBQm0zlmRRGqa3iOzWtCtpB7X9A58aBb1LLhNOk8KhMvF09SBh_5R1LSnqJB-vNlcBXInUDJFsiIsZxyUhU33Lsc7eW5mOdzwHPAiJnqzTlwzlJ689o4ZzYX0m7GL6QUl1pGIbZxFbESwgecN_QR5LN8pUZJ9Av9b8WJdz6M9aCOVVN6ZzRI82A-24o2lHNS20wg
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"InternationalScheduledPaymentId": "672d6dc9-bf61-4cfe-b14d-eecfc5c0970b",
"ConsentId": "20ae99ae-7a47-4e8a-a117-adf3199d8a1e",
"CreationDateTime": "2019-02-06T13:17:03+00:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2019-02-06T13:17:03+00:00",
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"ExchangeRate": 1.2,
"RateType": "Indicative",
},
"Refund": {
"Account": {
"SchemeName": "UK.OBIE.SortCodeAccountNumber",
"Identification": "08080021325677",
"Name": "NTPC Inc"
},
"Creditor": {
"Name": "NameTest",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": []
}
"Agent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "Test",
"PostalAddress": {
"AddressType": "Residential",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test",
"Country": "HR",
"AddressLine": [
"Test2",
"Test3",
"Test4"
]
},
"Initiation": {
"InstructionIdentification": "ACME412331",
"LocalInstrument": "UK.OBIE.SWIFT",
"InstructionPriority": "Normal",
"RequestedExecutionDateTime": "2019-02-10T05:00:00Z",
"CurrencyOfTransfer": "HRK",
"InstructedAmount": {
"Amount": "300.00",
"Currency": "HRK",
},
"ExchangeRateInformation": {
"UnitCurrency": "GBP",
"RateType": “Indicative”
},
"Creditor": {
"Name": "NameTest",
"PostalAddress": {
"AddressType": "Business",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test Town",
"Country": "HR",
"AddressLine": []
}
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "NBHRHR2XXXX",
"Name": "Test",
"PostalAddress": {
"AddressType": "Residential",
"Department": "ABC",
"SubDepartment": "DEF",
"StreetName": "Test Street",
"BuildingNumber": "Test Bldg Number",
"PostCode": "Test Code",
"TownName": "Test",
"Country": "HR",
"AddressLine": [
"Test2",
"Test3",
"Test4"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "HR1210010051863000160",
"Name": "ACME Inc",
"SecondaryIdentification": "ee"
},
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
},
"MultiAuthorisation": {
"Status": "Authorised",
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/international-scheduled-payments/672d6dc9-bf61-4cfe-b14d-eecfc5c0970b"
},
}File payments APIs
POST request: /file-payments
curl -X POST \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.0/pisp/file-payments/ \
-H 'Authorization: Bearer WGrmHFoaLbakpCNj4q5zvsCXj3Fd' \
-H 'Content-Type: application/json' \
-H ‘x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC' \
-H ‘x-fapi-customer-ip-address: 104.25.212.99' \
-H ‘x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
-H ‘Accept: application/json'\
-H 'Postman-Token: 24f41599-df05-473a-ba34-efbe0795f8e7' \
-H 'cache-control: no-cache' \
-H 'x-idempotency-key: FRESCO.21302.GFX.20' \
-H 'x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTQ1OTgwOCwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..xSrqT9OdjhZs3LpcT7_JXEyn6epCXddJf81p_BxV6DRYgOIbC8li3fnyaZQQVscMEQ5PHAO0JksG1nETpcIfI1qBEoqYdUZ---bkMbFGwC1pnK9upZYGDgcdrVRXkH_wN1te2ruuntPBtVhpNgSWfnQ1kNtRBHMEsbyrHsc2e3uOLMq1mqES2l1vj0GWuqoSPp0DPyFxt2V4cXWTPPnvme0_hUj6vYDVeg1VLOmz7x-AzQuTbR52BCAwq_5EDbvpRpDZp5spDvNz6ze9GH9mWL1S6V033NXhnWR21UI3mWlHss3F2bLAxusd9ufBr0y5HYdxnmAvn4j010ItxuHNeA' \
-d '{"Data":{"ConsentId": "8cab7d3b-f759-4e65-847c-b1006d393be1","Initiation":{"FileType":"UK.OBIE.pain.001.001.08","FileHash":"CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=","FileReference":"GB2OK238","NumberOfTransactions":"101","ControlSum":444.00,"RequestedExecutionDateTime":"2019-12-30T18:00:00-06:00","LocalInstrument":"UK.OBIE.BACS","RemittanceInformation":{"Reference":"FRESCO-101","Unstructured":"Internal ops code 5120101"}}}}'POST response: /file-payments
HTTP/1.1 201 Created
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTQ1OTgwOCwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..xSrqT9OdjhZs3LpcT7_JXEyn6epCXddJf81p_BxV6DRYgOIbC8li3fnyaZQQVscMEQ5PHAO0JksG1nETpcIfI1qBEoqYdUZ---bkMbFGwC1pnK9upZYGDgcdrVRXkH_wN1te2ruuntPBtVhpNgSWfnQ1kNtRBHMEsbyrHsc2e3uOLMq1mqES2l1vj0GWuqoSPp0DPyFxt2V4cXWTPPnvme0_hUj6vYDVeg1VLOmz7x-AzQuTbR52BCAwq_5EDbvpRpDZp5spDvNz6ze9GH9mWL1S6V033NXhnWR21UI3mWlHss3F2bLAxusd9ufBr0y5HYdxnmAvn4j010ItxuHNeA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"FilePaymentId": "9d6d47dc-08ea-43e4-9243-76f2ed166e7d",
"ConsentId": "8cab7d3b-f759-4e65-847c-b1006d393be1",
"CreationDateTime": "2019-02-06T13:31:12+00:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2019-02-06T13:31:12+00:00",
"Initiation": {
"FileType": "UK.OBIE.pain.001.001.08",
"FileHash": "CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=",
"FileReference": "GB2OK238",
"NumberOfTransactions": "101",
"ControlSum": 444,
"RequestedExecutionDateTime": "2019-12-30T18:00:00-06:00",
"LocalInstrument": "UK.OBIE.BACS",
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/file-payments/9d6d47dc-08ea-43e4-9243-76f2ed166e7d"
},
"Meta": {}
}GET request : /file-payments/{FilePaymentId}
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/file-payments/9d6d47dc-08ea-43e4-9243-76f2ed166e7d \
-H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: e493005f-850a-4d33-9085-3071eb65b3ac' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
GET response: /file-payments/{FilePaymentId}
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTQ1OTgwOCwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..xSrqT9OdjhZs3LpcT7_JXEyn6epCXddJf81p_BxV6DRYgOIbC8li3fnyaZQQVscMEQ5PHAO0JksG1nETpcIfI1qBEoqYdUZ---bkMbFGwC1pnK9upZYGDgcdrVRXkH_wN1te2ruuntPBtVhpNgSWfnQ1kNtRBHMEsbyrHsc2e3uOLMq1mqES2l1vj0GWuqoSPp0DPyFxt2V4cXWTPPnvme0_hUj6vYDVeg1VLOmz7x-AzQuTbR52BCAwq_5EDbvpRpDZp5spDvNz6ze9GH9mWL1S6V033NXhnWR21UI3mWlHss3F2bLAxusd9ufBr0y5HYdxnmAvn4j010ItxuHNeA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
{
"Data": {
"FilePaymentId": "9d6d47dc-08ea-43e4-9243-76f2ed166e7d",
"ConsentId": "8cab7d3b-f759-4e65-847c-b1006d393be1",
"CreationDateTime": "2019-02-06T13:22:36+00:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2019-02-06T13:22:36+00:00",
"Initiation": {
"FileType": "UK.OBIE.pain.001.001.08",
"FileHash": "CCiFOEK4V/cU/z0wNKs4MC1ElwBf0qQf23qVzNC/tHU=",
"FileReference": "GB2OK238",
"NumberOfTransactions": "101",
"ControlSum": 444,
"RequestedExecutionDateTime": "2019-12-30T18:00:00-06:00",
"LocalInstrument": "UK.OBIE.BACS",
"RemittanceInformation": {
"Unstructured": "Internal ops code 5120101",
"Reference": "FRESCO-101"
}
}
},
"Links": {
"Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/file-payments/9d6d47dc-08ea-43e4-9243-76f2ed166e7d"
},
"Meta": {}
}GET request: /file-payments/{FilePaymentId}/report-file
This is only applicable for ROI.
This endpoint returns the status in a PAIN.002 format in the HTTP response body.
curl -X GET \
https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/pisp/file-payments/9d6d47dc-08ea-43e4-9243-76f2ed166e7d/report-file \
-H 'Authorization: Bearer jplwuoVyzqRi4UIzB2xvT0b3cGBy' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: c56b5c8e-c1f3-42c8-86e8-7e5a82845d7d' \
-H 'cache-control: no-cache' \
-H 'x-fapi-customer-ip-address: 104.25.212.99' \
-H 'x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC' \
-H 'x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e' \
GET response: /file-payments request/{FilePaymentId}/report-file
HTTP/1.1 200 OK
x-jws-signature: eyJiNjQiOmZhbHNlLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTU0OTQ1OTgwOCwiY3JpdCI6WyJiNjQiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIl0sImtpZCI6IkNiRnhjLVRFbkNTRmMwcnhsMGN6TldTZXlwSSIsImN0eSI6ImFwcGxpY2F0aW9uXC9qc29uIiwidHlwIjoiSk9TRSIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvaXNzIjoiQ049MWlKRmdVS3ZiSFdmVzFnN1FQOG4zNSxPVT0wMDE1ODAwMDAwamZROWFBQUUsTz1PcGVuQmFua2luZyxDPUdCIiwiYWxnIjoiUlMyNTYifQ..xSrqT9OdjhZs3LpcT7_JXEyn6epCXddJf81p_BxV6DRYgOIbC8li3fnyaZQQVscMEQ5PHAO0JksG1nETpcIfI1qBEoqYdUZ---bkMbFGwC1pnK9upZYGDgcdrVRXkH_wN1te2ruuntPBtVhpNgSWfnQ1kNtRBHMEsbyrHsc2e3uOLMq1mqES2l1vj0GWuqoSPp0DPyFxt2V4cXWTPPnvme0_hUj6vYDVeg1VLOmz7x-AzQuTbR52BCAwq_5EDbvpRpDZp5spDvNz6ze9GH9mWL1S6V033NXhnWR21UI3mWlHss3F2bLAxusd9ufBr0y5HYdxnmAvn4j010ItxuHNeA
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460e
Content-Type: application/json
[File –Data]
<?xml version="1.0" encoding="utf-8"?><Document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:iso:std:iso:20022:tech:xsd:pain.002.001.03"><CstmrPmtStsRpt><GrpHdr><MsgId>16a6970056f0057Exp1</MsgId><CreDtTm>2019-04-29T15:16:31</CreDtTm><DbtrAgt><FinInstnId><BIC>BOFIIE2DXXX</BIC></FinInstnId></DbtrAgt></GrpHdr><OrgnlGrpInfAndSts><OrgnlMsgId>U52019AUTO144</OrgnlMsgId><OrgnlMsgNmId>pain.001.001.03</OrgnlMsgNmId></OrgnlGrpInfAndSts><OrgnlPmtInfAndSts><OrgnlPmtInfId>PMTINFID1220</OrgnlPmtInfId><TxInfAndSts><StsId>91191903657278</StsId><OrgnlInstrId>INSID23420</OrgnlInstrId><OrgnlEndToEndId>E2EID2320</OrgnlEndToEndId><TxSts>RJCT</TxSts><StsRsnInf><Orgtr><Id><OrgId><BICOrBEI>BOFIIE2D</BICOrBEI></OrgId></Id></Orgtr><Rsn><Cd>AC06</Cd></Rsn></StsRsnInf><OrgnlTxRef><Amt><InstdAmt Ccy="EUR">10</InstdAmt></Amt><ReqdExctnDt>2021-07-09</ReqdExctnDt><PmtTpInf><SvcLvl><Cd>SEPA</Cd></SvcLvl></PmtTpInf><PmtMtd>TRF</PmtMtd><RmtInf><Ustrd>USER001</Ustrd></RmtInf><Dbtr><Nm>Jane Doe</Nm><PstlAdr><Ctry>IE</Ctry><AdrLine>Debtor_Address1</AdrLine><AdrLine>Debtor_Address2</AdrLine></PstlAdr></Dbtr><DbtrAcct><Id><IBAN>IE43BOFI90159797017815</IBAN></Id><Ccy>EUR</Ccy></DbtrAcct><DbtrAgt><FinInstnId><BIC>BOFIIE2D</BIC></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BIC>BOFIIE2D</BIC></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>IE47BOFI90126312660908</IBAN></Id></CdtrAcct></OrgnlTxRef></TxInfAndSts></OrgnlPmtInfAndSts></CstmrPmtStsRpt></Document>